Filter Attributes - Current Value Service Attributes
The following filter attributes represent properties from the point’s CVS record. They are available for use throughout CygNet Software.
Current Values
| Attribute | Attribute Name | Description | User Values |
|---|---|---|---|
|
Alarm Acknowledge |
alarmack |
This attribute is used for filtering on whether the point’s alarm condition is acknowledged. |
Yes or No |
|
Alarm Priority Category |
alarmprioritycat |
This attribute is used for filtering on the alarm priority category. |
1, 2, 3, or 4 |
|
Alarm Priority Category Description |
alarmprioritycategorydesc value |
This attribute is used for filtering on a description of the alarm priority category, (for example, Low Alarm Priority, Critical Alarm Priority, High Alarm Priority etc.) |
Text |
|
Alarm Record Version |
alarmrecversion |
This attribute is used for filtering on the current record version for the tag in the CAS. |
Numeric |
|
Alternate Units |
altunits |
This attribute is used for filtering on the point’s alternate, or secondary, units (liter vs. US gal, meter vs. yard etc.) |
Text |
|
Alternate Value |
alternatevalue |
This attribute is used for filtering on the point’s alternate numeric value. |
Numeric |
|
Description |
description |
This attribute is used for filtering on the description of a point’s UDC (for example, Tank Level, Pump Status, Static Pressure, etc.) |
Text |
|
Point State Background Color |
pointstatebackcolor |
This attribute is used for filtering on the point state’s background color of the alarm (for example, 00FFFF (yellow), FF00FF (magenta), FF0000 (red), 00FF00 (green), 00FFFF (cyan) etc.) |
Hexadecimal |
|
Point State Blink Method |
pointstateblinkmethod |
This attribute is used for filtering on the point state’s blink method for the alarm. If no blink method is specified, the default is 00 - none. See Understanding the CVS Metadata File for more information about defining blink method in the XML PointSchemes element. |
Numeric |
|
Point State Description |
pointstatedescription |
This attribute is used for filtering on the description of the point state for the alarm, such as Analog Low Warning, Analog Normal, Unreliable, etc. |
Text |
|
Point State Foreground Color |
pointstateforecolor |
This attribute is used for filtering on the point state’s foreground color of the alarm, such as 000000 for black. |
Hexadecimal |
|
Point State Name |
pointstatename |
This attribute is used for filtering on the name of the point state, such as HIGH_ALARM, NORMAL, LOW_WARNING, UNRELIABLE, etc. |
Text |
|
Point State Single Color |
pointstatesinglecolor |
This attribute is used for filtering on the point state’s single color of the alarm (for example, 00FFFF (yellow), FF00FF (magenta), FF0000 (red), 00FF00 (green), 00FFFF (cyan) etc.) |
Numeric |
|
Point State Token |
pointstatetoken |
This attribute is used for filtering on a point state token. |
Text |
|
Point Status |
pointstatus |
This attribute is used for filtering on the status of a point that is in an alarm condition (for example, 00000000080000) |
Numeric |
|
Primary Units |
priunits |
This attribute is used for filtering on the primary units of measure for a point value (for example, ms, USgal, %) |
Alphanumeric |
|
Primary Value |
primaryvalue |
This attribute is used for filtering on the primary value. The attribute can be a decimal point, a date, a timestamp, a whole number, or text, such as “Running.” |
Alphanumeric |
|
Status |
status |
This attribute is used for filtering on an internal number that corresponds to the point’s current status. |
Numeric |
|
Timestamp |
timestamp |
This attribute is used for filtering on the timestamp for when the point’s alarm condition is evaluated and processed. See Timestamps in the Data section for more information. |
Numeric (time) |
|
Units |
units |
This attribute is used for filtering on the units for the point. Example of units: psi, ms, F, C, %, etc. |
Text (alphanumeric) |
|
User Status |
userstatus |
This attribute is used for filtering on the point’s user status. It is an internal number that corresponds to the point’s current status. |
Numeric |
|
Value |
value |
This attribute is used for filtering on the value. |
Numeric |
Current Value Status Bits Tokens
| Attribute | Attribute Name | Description | User Values |
|---|---|---|---|
|
Is Configurable Bit 1 - 15 Set |
is_cfgbit01_set - is_cfgbit15_set |
These attributes are used for filtering on whether the Configurable Bits 1 - 15 are set. |
Yes or No |
|
Is External Value Bit Set |
is_externalvalue_set |
This attribute is used for filtering on whether the External Value Bit is set. |
Yes or No |
|
Is Unreliable Bit Set |
is_unreliable_set |
This attribute is used for filtering on whether the Unreliable Bit is set. |
Yes or No |
|
Is User Bit 1 - 16 Set |
is_userbit01_set - is_userbit16_set |
These attributes are used for filtering on whether the User Bits 1 - 16 are set. |
Yes or No |
